com.inscoper.nbo.SpinningDisk¶

Represents the XML element SpinningDisk. More...

Inherits from com.inscoper.nbo.ConfocalScanner_Type, com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	SpinningDisk()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setSingleDisk(boolean value, boolean validate) Sets the value of the SingleDisk attribute.
void	setSingleDisk(boolean value) Sets the value of the SingleDisk attribute.
boolean	getSingleDisk() Returns the value of the SingleDisk attribute.
void	resetSingleDisk() Resets the SingleDisk attribute to an unset state.
boolean	hasSingleDisk() Checks whether the SingleDisk attribute is present.
void	setDiskSpeed(float value, boolean validate) Sets the value of the DiskSpeed attribute.
void	setDiskSpeed(float value) Sets the value of the DiskSpeed attribute.
float	getDiskSpeed() Returns the value of the DiskSpeed attribute.
void	resetDiskSpeed() Resets the DiskSpeed attribute to an unset state.
boolean	hasDiskSpeed() Checks whether the DiskSpeed attribute is present.
void	setDiskSpeedUnit(UnitsVelocity_Type value, boolean validate) Sets the value of the DiskSpeedUnit attribute.
void	setDiskSpeedUnit(UnitsVelocity_Type value) Sets the value of the DiskSpeedUnit attribute.
UnitsVelocity_Type	getDiskSpeedUnit() Returns the value of the DiskSpeedUnit attribute.
void	resetDiskSpeedUnit() Resets the DiskSpeedUnit attribute to an unset state.
boolean	hasDiskSpeedUnit() Checks whether the optional DiskSpeedUnit attribute is present.
SpinningDisk	__internal_create(long cPtr, boolean own)
SpinningDisk	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

Protected Functions¶

	Name
	SpinningDisk(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(SpinningDisk obj)

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.ConfocalScanner_Type

	Name
	ConfocalScanner_Type()
void	setID(ConfocalScannerID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(ConfocalScannerID_Type value) Sets the value of the ID attribute.
ConfocalScannerID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value, boolean validate) Sets the value of the Name attribute.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setNrOfScanPoints(int value, boolean validate) Sets the value of the NrOfScanPoints attribute.
void	setNrOfScanPoints(int value) Sets the value of the NrOfScanPoints attribute.
int	getNrOfScanPoints() Returns the value of the NrOfScanPoints attribute.
void	resetNrOfScanPoints() Resets the NrOfScanPoints attribute to an unset state.
boolean	hasNrOfScanPoints() Checks whether the NrOfScanPoints attribute is present.
void	setMaxFrameRate(float value, boolean validate) Sets the value of the MaxFrameRate attribute.
void	setMaxFrameRate(float value) Sets the value of the MaxFrameRate attribute.
float	getMaxFrameRate() Returns the value of the MaxFrameRate attribute.
void	resetMaxFrameRate() Resets the MaxFrameRate attribute to an unset state.
boolean	hasMaxFrameRate() Checks whether the MaxFrameRate attribute is present.
void	setMaxFrameRateUnit(UnitsFrequency_Type value, boolean validate) Sets the value of the MaxFrameRateUnit attribute.
void	setMaxFrameRateUnit(UnitsFrequency_Type value) Sets the value of the MaxFrameRateUnit attribute.
UnitsFrequency_Type	getMaxFrameRateUnit() Returns the value of the MaxFrameRateUnit attribute.
void	resetMaxFrameRateUnit() Resets the MaxFrameRateUnit attribute to an unset state.
boolean	hasMaxFrameRateUnit() Checks whether the optional MaxFrameRateUnit attribute is present.
void	setPointsConfiguration(String value, boolean validate) Sets the value of the PointsConfiguration attribute.
void	setPointsConfiguration(String value) Sets the value of the PointsConfiguration attribute.
String	getPointsConfiguration() Returns the value of the PointsConfiguration attribute.
void	resetPointsConfiguration() Resets the PointsConfiguration attribute to an unset state.
boolean	hasPointsConfiguration() Checks whether the PointsConfiguration attribute is present.
void	setAnnotationRef(AnnotationRef value, boolean validate) Sets the value of the AnnotationRef element.
void	setAnnotationRef(AnnotationRef value) Sets the value of the AnnotationRef element.
AnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.
StringSet	getPointsConfigurationAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.ConfocalScanner_Type

	Name
	ConfocalScanner_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.SpinningDisk;

Represents the XML element SpinningDisk.

A Spinning disk confocal scanner is a device in which the scanning of the illuminated and detected spots is performed simultaneously using an opaque disk called a Nipkow disk, which has many ideally identical small holes arranged in Archimedean spirals. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.delete

function SpinningDisk¶

public SpinningDisk()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.getNBOType

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromJsonFile

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromJsonFile

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromJsonString

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromJsonString

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromXmlFile

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromXmlFile

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromXmlString

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromXmlString

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.toXmlFile

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.toXmlFile

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.toXmlString

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.toXmlString

function setSingleDisk¶

public void setSingleDisk(
    boolean value,
    boolean validate
)

Sets the value of the SingleDisk attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.

function setSingleDisk¶

public void setSingleDisk(
    boolean value
)

Sets the value of the SingleDisk attribute.

Parameters:

value The value to set

This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.

function getSingleDisk¶

public boolean getSingleDisk()

Returns the value of the SingleDisk attribute.

Return: The value of the attribute

This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.

function resetSingleDisk¶

public void resetSingleDisk()

Resets the SingleDisk attribute to an unset state.

This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.

function hasSingleDisk¶

public boolean hasSingleDisk()

Checks whether the SingleDisk attribute is present.

Return: true if the attribute has been set, false otherwise

This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.

function setDiskSpeed¶

public void setDiskSpeed(
    float value,
    boolean validate
)

Sets the value of the DiskSpeed attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.

function setDiskSpeed¶

public void setDiskSpeed(
    float value
)

Sets the value of the DiskSpeed attribute.

Parameters:

value The value to set

This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.

function getDiskSpeed¶

public float getDiskSpeed()

Returns the value of the DiskSpeed attribute.

Return: The value of the attribute

This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.

function resetDiskSpeed¶

public void resetDiskSpeed()

Resets the DiskSpeed attribute to an unset state.

This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.

function hasDiskSpeed¶

public boolean hasDiskSpeed()

Checks whether the DiskSpeed attribute is present.

Return: true if the attribute has been set, false otherwise

This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.

function setDiskSpeedUnit¶

public void setDiskSpeedUnit(
    UnitsVelocity_Type value,
    boolean validate
)

Sets the value of the DiskSpeedUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.